home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 / MACD 5.bin / workbench / tools / czesc_2 / interfaces / guispell-1.3 / minrexx.c < prev    next >
C/C++ Source or Header  |  1993-04-21  |  17KB  |  502 lines
  1. /*
  2.  *   This is an example of how REXX messages might be handled.  This is
  3.  *   a `minimum' example that both accepts asynchronous REXX messages and
  4.  *   can request REXX service [and can issue simple REXX commands to other
  5.  *   rexx servers -ljr].
  6.  *
  7.  *   Read this entire file!  It's short enough.
  8.  *
  9.  *   It is written in such a fashion that it can be attached to a program
  10.  *   with a minimum of fuss.  The only external symbols it makes available
  11.  *   are the [eight] functions.
  12.  *   [Note that the application must now declare, open, and close
  13.  *    RexxSysBase. -ljr]
  14.  *
  15.  *   This code is by Radical Eye Software, but it is put in the public
  16.  *   domain.  I would appreciate it if the following string was left in
  17.  *   both as a version check and as thanks from you for the use of this
  18.  *   code.
  19.  *
  20.  *   If you modify this file for your own use, don't bump the version
  21.  *   number; add a suffix, such as 1.0a or 1.0.3 or something, so we
  22.  *   don't have fake `versions' floating around.
  23.  *
  24.  *   Simple command issuing extensions by
  25.  *   Loren J. Rittle  Thu Dec 05 01:33:46 1991
  26.  */
  27. static char *blurb =
  28. "Radical Eye MinRexx 0.4ljr (with simple command issuing extensions)";
  29.  
  30. /*
  31.  *  The application *must* declare, open (before calling any minrexx code),
  32.  *  and close (after calling any/all minrexx code) RexxSysBase. -ljr
  33.  */
  34.  
  35. /*
  36.  *   We read in our own personal little include.
  37.  */
  38. #include <string.h>
  39. #pragma msg 148 ignore push
  40. #pragma msg 149 ignore push
  41. #pragma msg 61 ignore push
  42. #include <proto/exec.h>
  43. #include <proto/rexxsyslib.h>
  44. #pragma msg 149 pop
  45. #pragma msg 61 pop
  46. #include "libraries.h"
  47. #include "minrexx.h"
  48.  
  49. static int cmdcmp (char *c, char *m);
  50. static void replytoit (struct RexxMsg *msg);
  51.  
  52. /*
  53.  *   All of our local globals, hidden from sight.
  54.  */
  55. static struct MsgPort *rexxPort;/* this is *our* rexx port */
  56. static int bringerdown;        /* are we trying to shut down? */
  57. static struct rexxCommandList *globalrcl;    /* our command association list */
  58. static long stillNeedReplies;    /* how many replies are pending? */
  59. static long rexxPortBit;    /* what bit to wait on for Rexx? */
  60. static char *extension;        /* the extension for macros */
  61. static void (*userdisp) (struct RexxMsg *, struct rexxCommandList *, char *);    /* the user's dispatch function */
  62. static struct RexxMsg *oRexxMsg;/* the outstanding Rexx message */
  63.  
  64. /*
  65.  *   This is the main entry point into this code.
  66.  */
  67. long upRexxPort (char *s, struct rexxCommandList *rcl, char *exten, void(*uf)(struct RexxMsg *, struct rexxCommandList *, char *))
  68. /*
  69.  *   The first argument is the name of your port to be registered;
  70.  *   this will be used, for instance, with the `address' command of ARexx.
  71.  *   The second argument is an association list of command-name/user-data
  72.  *   pairs.  It's an array of struct rexxCommandList, terminated by a
  73.  *   structure with a NULL in the name field. The commands are case
  74.  *   sensitive.  The user-data field can contain anything appropriate,
  75.  *   perhaps a function to call or some other data.
  76.  *   The third argument is the file extension for ARexx macros invoked
  77.  *   by this program.  If you supply this argument, any `primitive' not
  78.  *   in the association list rcl will be sent out to ARexx for
  79.  *   interpretation, thus allowing macro programs to work just like
  80.  *   primitives.  If you do not want this behavior, supply a `NULL'
  81.  *   here, and those commands not understood will be replied with an
  82.  *   error value of RXERRORNOCMD.
  83.  *   The fourth argument is the user dispatch function.  This function
  84.  *   will *only* be called from rexxDisp(), either from the user calling
  85.  *   this function directly, or from dnRexxPort().  Anytime a command
  86.  *   match is found in the association list, this user-supplied function
  87.  *   will be called with two arguments---the Rexx message that was
  88.  *   received, and a pointer to the association pair.  This function
  89.  *   should return a `1' if the message was replied to by the function
  90.  *   and a `0' if the default success code of (0, 0) should be returned.
  91.  *   Note that the user function should never ReplyMsg() the message;
  92.  *   instead he should indicate the return values with replyRexxCmd();
  93.  *   otherwise we lose track of the messages that still lack replies.
  94.  *   upRexxPort() returns the signal bit to wait on for Rexx messages.
  95.  *   If something goes wrong, it simply returns a `0'.  Note that this
  96.  *   function is safe to call multiple times because we check to make
  97.  *   sure we haven't opened already.  It's also a quick way to change
  98.  *   the association list or dispatch function.
  99.  */
  100. {
  101.  
  102. /*
  103.  *   Some basic error checking.
  104.  */
  105.   if (rcl == NULL || uf == NULL)
  106.     return (0L);
  107. /*
  108.  *   If we aren't open, we make sure no one else has opened a port with
  109.  *   this name already.  If that works, and the createport succeeds, we
  110.  *   fill rexxPortBit with the value to return.
  111.  *
  112.  *   Note that rexxPortBit will be 0 iff rexxPort is NULL, so the check
  113.  *   for rexxPort == NULL also insures that our rexxPortBit is 0.
  114.  */
  115.   if (rexxPort == NULL)
  116.     {
  117.       Forbid ();
  118.       if (FindPort (s) == NULL)
  119.     rexxPort = CreatePort (s, 0L);
  120.       Permit ();
  121.       if (rexxPort != NULL)
  122.     rexxPortBit = 1L << rexxPort->mp_SigBit;
  123.     }
  124. /*
  125.  *   Squirrel away these values for our own internal access, and return
  126.  *   the wait bit.
  127.  */
  128.   globalrcl = rcl;
  129.   extension = exten;
  130.   userdisp = uf;
  131.   return (rexxPortBit);
  132. }
  133.  
  134. /*
  135.  *   This function closes down the Rexx port.  It is always safe to
  136.  *   call, and should *definitely* be made a part of your cleanup
  137.  *   routine.  No arguments and no return.  It removes the Rexx port,
  138.  *   replies to all of the messages and insures that we get replies
  139.  *   to all the ones we sent out, closes the Rexx library, deletes the
  140.  *   port, clears a few flags, and leaves.
  141.  */
  142. void dnRexxPort (void)
  143. {
  144.   if (rexxPort)
  145.     {
  146.       RemPort (rexxPort);
  147.       bringerdown = 1;
  148. /*
  149.  *   A message still hanging around?  We kill it off.
  150.  */
  151.       if (oRexxMsg)
  152.     {
  153.       oRexxMsg->rm_Result1 = RXERRORIMGONE;
  154.       ReplyMsg ((struct Message *)oRexxMsg);
  155.       oRexxMsg = NULL;
  156.     }
  157.       while (stillNeedReplies)
  158.     {
  159.       WaitPort (rexxPort);
  160.       dispRexxPort ();
  161.     }
  162.       DeletePort (rexxPort);
  163.       rexxPort = NULL;
  164.     }
  165.   rexxPortBit = 0;
  166. }
  167.  
  168. /*
  169.  *   Here we dispatch any REXX messages that might be outstanding.
  170.  *   This is the main routine for handling Rexx messages.
  171.  *   This function is fast if no messages are outstanding, so it's
  172.  *   pretty safe to call fairly often.
  173.  *
  174.  *   If we are bring the system down and flushing messages, we reply
  175.  *   with a pretty serious return code RXERRORIMGONE.
  176.  *
  177.  *   No arguments, no returns.
  178.  */
  179. void dispRexxPort (void)
  180. {
  181.   register struct RexxMsg *RexxMsg;
  182.   register struct rexxCommandList *rcl;
  183.   register char *p;
  184.   register int dontreply;
  185.  
  186. /*
  187.  *   If there's no rexx port, we're out of here.
  188.  */
  189.   if (rexxPort == NULL)
  190.     return;
  191. /*
  192.  *   Otherwise we have our normal loop on messages.
  193.  */
  194.   while (RexxMsg = (struct RexxMsg *) GetMsg (rexxPort))
  195.     {
  196. /*
  197.  *   If we have a reply to a message we sent, we look at the second
  198.  *   argument.  If it's set, it's a function we are supposed to call
  199.  *   so we call it.  Then, we kill the argstring and the message
  200.  *   itself, decrement the outstanding count, and attempt to close
  201.  *   down the Rexx library.  Note that this call only succeeds if
  202.  *   there are no outstanding messages.  Also, it's pretty quick, so
  203.  *   don't talk to me about efficiency.
  204.  */
  205.       if (RexxMsg->rm_Node.mn_Node.ln_Type == NT_REPLYMSG)
  206.     {
  207.       if (RexxMsg->rm_Args[1])
  208.         {
  209.           (*((int (*) (struct RexxMsg *)) (RexxMsg->rm_Args[1]))) (RexxMsg);
  210.         }
  211.       DeleteArgstring (RexxMsg->rm_Args[0]);
  212.       DeleteRexxMsg (RexxMsg);
  213.       stillNeedReplies--;
  214. /*
  215.  *   The default case is we got a message and we need to check it for
  216.  *   primitives.  We skip past any initial tabs or spaces and initialize
  217.  *   the return code fields.
  218.  */
  219.     }
  220.       else
  221.     {
  222.       p = (char *) RexxMsg->rm_Args[0];
  223.       while (*p > 0 && *p <= ' ')
  224.         p++;
  225.       RexxMsg->rm_Result1 = 0;
  226.       RexxMsg->rm_Result2 = 0;
  227. /*
  228.  *   If somehow the reply is already done or postponed, `dontreply' is
  229.  *   set.
  230.  */
  231.       dontreply = 0;
  232. /*
  233.  *   If the sky is falling, we just blow up and replymsg.
  234.  */
  235.       if (bringerdown)
  236.         {
  237.           RexxMsg->rm_Result1 = RXERRORIMGONE;
  238. /*
  239.  *   Otherwise we cdr down our association list, comparing commands,
  240.  *   until we get a match.  If we get a match, we call the dispatch
  241.  *   function with the appropriate arguments, and break out.
  242.  */
  243.         }
  244.       else
  245.         {
  246.           oRexxMsg = RexxMsg;
  247.           for (rcl = globalrcl; rcl->name; rcl++)
  248.         {
  249.           if (cmdcmp (rcl->name, p) == 0)
  250.             {
  251.               if (p[strlen (rcl->name)])
  252.             (*userdisp) (RexxMsg, rcl, p + strlen (rcl->name) + 1);
  253.               else
  254.             (*userdisp) (RexxMsg, rcl, p + strlen (rcl->name));
  255.               break;
  256.             }
  257.         }
  258. /*
  259.  *   If we broke out, rcl will point to the command we executed; if we
  260.  *   are at the end of the list, we didn't understand the command.  In
  261.  *   this case, if we were supplied an extension in upRexxPort, we know
  262.  *   that we should send the command out, so we do so, synchronously.
  263.  *   The synchronous send takes care of our reply.  If we were given a
  264.  *   NULL extension, we bitch that the command didn't make sense to us.
  265.  */
  266.           if (rcl->name == NULL)
  267.         {
  268.           if (extension)
  269.             {
  270.               syncRexxCmd (RexxMsg->rm_Args[0], RexxMsg);
  271.               dontreply = 1;
  272.             }
  273.           else
  274.             {
  275.               RexxMsg->rm_Result1 = RXERRORNOCMD;
  276.             }
  277.         }
  278.         }
  279. /*
  280.  *   Finally, reply if appropriate.
  281.  */
  282.       oRexxMsg = NULL;
  283.       if (!dontreply)
  284.         ReplyMsg ((struct Message *)RexxMsg);
  285.     }
  286.     }
  287. }
  288.  
  289. /*
  290.  *   This is the function we use to see if the command matches
  291.  *   the command string.  Not case sensitive.  Make sure all commands
  292.  *   are given in lower case!
  293.  */
  294. static int cmdcmp (char *c, char *m)
  295. {
  296.   while (*c && ((*c == *m) || (*c == *m + 32 && ('a' <= *c && *c <= 'z'))))
  297.     {
  298.       c++;
  299.       m++;
  300.     }
  301.   if (!(*c) && *m)
  302.     return ((int) *m != ' ');
  303.   return ((int) *c);
  304. }
  305.  
  306. /*
  307.  *   This is the general ARexx command interface, but is not the one
  308.  *   you will use most of the time; ones defined later are easier to
  309.  *   understand and use.  But they all go through here.
  310.  */
  311. struct RexxMsg *sendRexxCmd (char *s, void (*f)(struct RexxMsg *), STRPTR p1, STRPTR p2, STRPTR p3)
  312. /*
  313.  *   The first parameter is the command to send to Rexx.
  314.  *   The second parameter is either NULL, indicating that the command
  315.  *   should execute asynchronously, or a function to be called when the
  316.  *   message we build up and send out here finally returns.  Please note
  317.  *   that the function supplied here could be called during cleanup after
  318.  *   a fatal error, so make sure it is `safe'.  This function always is
  319.  *   passed one argument, the RexxMsg that is being replied.
  320.  *   These are up to three arguments to be stuffed into the RexxMsg we
  321.  *   are building up, making the values available when the message is
  322.  *   finally replied to.  The values are stuffed into Args[2]..Args[4].
  323.  */
  324. {
  325.   register struct MsgPort *rexxport;
  326.   register struct RexxMsg *RexxMsg;
  327.  
  328. /*
  329.  *   If we have too many replies out there, we just return failure.
  330.  *   Note that you should check the return code to make sure your
  331.  *   message got out!  Then, we forbid, and make sure that:
  332.  *      - we have a rexx port open
  333.  *      - Rexx is out there
  334.  *      - the library is open
  335.  *      - we can create a message
  336.  *      - we can create an argstring
  337.  *
  338.  *   If all of these succeed, we stuff a few values and send the
  339.  *   message, permit, and return.
  340.  */
  341.   if (rexxPort == NULL || stillNeedReplies > MAXRXOUTSTANDING - 1)
  342.     return (NULL);
  343.   if ((RexxMsg = CreateRexxMsg (rexxPort, extension, rexxPort->mp_Node.ln_Name)) &&
  344.       (RexxMsg->rm_Args[0] = CreateArgstring (s, strlen (s))))
  345.     {
  346.       RexxMsg->rm_Action = RXCOMM;
  347.       RexxMsg->rm_Args[1] = (STRPTR) f;
  348.       RexxMsg->rm_Args[2] = p1;
  349.       RexxMsg->rm_Args[3] = p2;
  350.       RexxMsg->rm_Args[4] = p3;
  351.       RexxMsg->rm_Node.mn_Node.ln_Name = RXSDIR;
  352.       Forbid ();
  353.       if (rexxport = FindPort (RXSDIR))
  354.     PutMsg (rexxport, (struct Message *)RexxMsg);
  355.       Permit ();
  356.       if (rexxport)
  357.     {
  358.       stillNeedReplies++;
  359.       return (RexxMsg);
  360.     }
  361.       else
  362.     DeleteArgstring (RexxMsg->rm_Args[0]);
  363.     }
  364.   if (RexxMsg)
  365.     DeleteRexxMsg (RexxMsg);
  366.   return (NULL);
  367. }
  368.  
  369. /*
  370.  *   This function is used to send out an ARexx message and return
  371.  *   immediately.  Its single parameter is the command to send.
  372.  */
  373. struct RexxMsg *asyncRexxCmd (char *s)
  374. {
  375.   return (sendRexxCmd (s, NULL, NULL, NULL, NULL));
  376. }
  377.  
  378. /*
  379.  *   This function sets things up to reply to the message that caused
  380.  *   it when we get a reply to the message we are sending out here.
  381.  *   But first the function we pass in, which actually handles the reply.
  382.  *   Note how we get the message from the Args[2]; Args[0] is the command,
  383.  *   Args[1] is this function, and Args[2]..Args[4] are any parameters
  384.  *   passed to sendRexxCmd() as p1..p3.  We pass the result codes right
  385.  *   along.
  386.  */
  387. static void replytoit (struct RexxMsg *msg)
  388. {
  389.   register struct RexxMsg *omsg;
  390.  
  391.   omsg = (struct RexxMsg *) (msg->rm_Args[2]);
  392.   replyRexxCmd (omsg, msg->rm_Result1, msg->rm_Result2, NULL);
  393.   ReplyMsg ((struct Message *)omsg);
  394. }
  395.  
  396. /*
  397.  *   This function makes use of everything we've put together so far,
  398.  *   and functions as a synchronous Rexx call; as soon as the macro
  399.  *   invoked here returns, we reply to `msg', passing the return codes
  400.  *   back.
  401.  */
  402. struct RexxMsg *syncRexxCmd (char *s, struct RexxMsg *msg)
  403. {
  404.   return (sendRexxCmd (s, &replytoit, (STRPTR)msg, NULL, NULL));
  405. }
  406.  
  407. /*
  408.  *   There are times when you want to pass back return codes or a
  409.  *   return string; call this function when you want to do that,
  410.  *   and return `1' from the user dispatch function so the main
  411.  *   event loop doesn't reply (because we reply here.)  This function
  412.  *   always returns 1.
  413.  */
  414. void replyRexxCmd (struct RexxMsg *msg, long primary, long secondary, char *string)
  415. /*
  416.  *   The first parameter is the message we are replying to.
  417.  *   The next two parameters are the primary and secondary return
  418.  *   codes.
  419.  *   The final parameter is a return string.  This string is only
  420.  *   returned if the primary return code is 0, and a string was
  421.  *   requested.
  422.  *
  423.  *   We also note that we have replied to the message that came in.
  424.  */
  425. {
  426. /*
  427.  *   Note how we make sure the Rexx Library is open before calling
  428.  *   CreateArgstring . . . and we close it down at the end, if possible.
  429.  */
  430.   if (primary == 0 && (msg->rm_Action & (1L << RXFB_RESULT)))
  431.     {
  432.       if (string)
  433.     secondary = (long) CreateArgstring (string, strlen (string));
  434.       else
  435.     secondary = 0L;
  436.     }
  437.   msg->rm_Result1 = primary;
  438.   msg->rm_Result2 = secondary;
  439. }
  440.  
  441. /*
  442.  *   This is the general simple command interface. Added by Loren J. Rittle
  443.  */
  444. struct RexxMsg *sendSimpleCmd (char *s, char *host, void (*f)(struct RexxMsg *), STRPTR p1, STRPTR p2, STRPTR p3)
  445. /*
  446.  *   The first parameter is the command to send to the host.
  447.  *   The second parameter is the name of the host to send to.
  448.  *   The thrid parameter is either NULL, indicating that the command
  449.  *   should execute asynchronously, or a function to be called when the
  450.  *   message we build up and send out here finally returns.  Please note
  451.  *   that the function supplied here could be called during cleanup after
  452.  *   a fatal error, so make sure it is `safe'.  This function always is
  453.  *   passed one argument, the RexxMsg that is being replied.
  454.  *   These are up to three arguments to be stuffed into the RexxMsg we
  455.  *   are building up, making the values available when the message is
  456.  *   finally replied to.  The values are stuffed into Args[2]..Args[4].
  457.  */
  458. {
  459.   register struct MsgPort *rexxport;
  460.   register struct RexxMsg *RexxMsg;
  461.  
  462. /*
  463.  *   If we have too many replies out there, we just return failure.
  464.  *   Note that you should check the return code to make sure your
  465.  *   message got out!  Then, we forbid, and make sure that:
  466.  *      - we have a rexx port open
  467.  *      - Rexx is out there
  468.  *      - the library is open
  469.  *      - we can create a message
  470.  *      - we can create an argstring
  471.  *
  472.  *   If all of these succeed, we stuff a few values and send the
  473.  *   message, permit, and return.
  474.  */
  475.   if (rexxPort == NULL || stillNeedReplies > MAXRXOUTSTANDING - 1)
  476.     return (NULL);
  477.   if ((RexxMsg = CreateRexxMsg (rexxPort, extension, rexxPort->mp_Node.ln_Name)) &&
  478.       (RexxMsg->rm_Args[0] = CreateArgstring (s, strlen (s))))
  479.     {
  480.       RexxMsg->rm_Action = RXCOMM | RXFF_NOIO | RXFF_RESULT | RXFF_STRING;
  481.       RexxMsg->rm_Args[1] = (STRPTR) f;
  482.       RexxMsg->rm_Args[2] = p1;
  483.       RexxMsg->rm_Args[3] = p2;
  484.       RexxMsg->rm_Args[4] = p3;
  485.       RexxMsg->rm_Node.mn_Node.ln_Name = host;
  486.       Forbid ();
  487.       if (rexxport = FindPort (host))
  488.     PutMsg (rexxport, (struct Message *)RexxMsg);
  489.       Permit ();
  490.       if (rexxport)
  491.     {
  492.       stillNeedReplies++;
  493.       return (RexxMsg);
  494.     }
  495.       else
  496.     DeleteArgstring (RexxMsg->rm_Args[0]);
  497.     }
  498.   if (RexxMsg)
  499.     DeleteRexxMsg (RexxMsg);
  500.   return (NULL);
  501. }
  502.